Create address - Hyperline

POST

customers

{customerId}

addresses

Create address

curl --request POST \
  --url https://api.hyperline.co/v1/customers/{customerId}/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "shipping",
  "name": "Acme",
  "line1": "5 rue de Paradis",
  "line2": null,
  "city": "Paris",
  "zip": "75010",
  "state": "CA",
  "country": "FR",
  "tax_id": "DE123456789"
}
'

import requests

url = "https://api.hyperline.co/v1/customers/{customerId}/addresses"

payload = {
    "type": "shipping",
    "name": "Acme",
    "line1": "5 rue de Paradis",
    "line2": None,
    "city": "Paris",
    "zip": "75010",
    "state": "CA",
    "country": "FR",
    "tax_id": "DE123456789"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'shipping',
    name: 'Acme',
    line1: '5 rue de Paradis',
    line2: null,
    city: 'Paris',
    zip: '75010',
    state: 'CA',
    country: 'FR',
    tax_id: 'DE123456789'
  })
};

fetch('https://api.hyperline.co/v1/customers/{customerId}/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/customers/{customerId}/addresses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'shipping',
    'name' => 'Acme',
    'line1' => '5 rue de Paradis',
    'line2' => null,
    'city' => 'Paris',
    'zip' => '75010',
    'state' => 'CA',
    'country' => 'FR',
    'tax_id' => 'DE123456789'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/customers/{customerId}/addresses"

	payload := strings.NewReader("{\n  \"type\": \"shipping\",\n  \"name\": \"Acme\",\n  \"line1\": \"5 rue de Paradis\",\n  \"line2\": null,\n  \"city\": \"Paris\",\n  \"zip\": \"75010\",\n  \"state\": \"CA\",\n  \"country\": \"FR\",\n  \"tax_id\": \"DE123456789\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperline.co/v1/customers/{customerId}/addresses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"shipping\",\n  \"name\": \"Acme\",\n  \"line1\": \"5 rue de Paradis\",\n  \"line2\": null,\n  \"city\": \"Paris\",\n  \"zip\": \"75010\",\n  \"state\": \"CA\",\n  \"country\": \"FR\",\n  \"tax_id\": \"DE123456789\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/customers/{customerId}/addresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"shipping\",\n  \"name\": \"Acme\",\n  \"line1\": \"5 rue de Paradis\",\n  \"line2\": null,\n  \"city\": \"Paris\",\n  \"zip\": \"75010\",\n  \"state\": \"CA\",\n  \"country\": \"FR\",\n  \"tax_id\": \"DE123456789\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "cad_abc123",
  "type": "shipping",
  "tax_id": "DE123456789",
  "name": "Acme",
  "line1": "5 rue de Paradis",
  "line2": null,
  "city": "Paris",
  "zip": "75010",
  "state": "CA",
  "country": "FR"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId

string

required

Body

application/json

type

enum<string>

required

Only shipping addresses can be created here. A customer has at most one active billing address, managed through the customer or by updating its address ID.

Available options:

shipping

Example:

"shipping"

name

string | null

Address name.

Example:

"Acme"

line1

string | null

Address first line.

Example:

"5 rue de Paradis"

line2

string | null

Address second line (optional).

Example:

null

city

string | null

Address city.

Example:

"Paris"

zip

string | null

Address ZIP code.

Example:

"75010"

state

string | null

State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. CA for US-CA) for:

United States: state, see ISO 3166-2:US
Canada: province or territory, see ISO 3166-2:CA
Italy: province, see ISO 3166-2:IT
Brazil: state, see ISO 3166-2:BR

A code or a name is accepted (e.g. ON or Ontario); a value that matches neither for these countries is rejected. For any other country, the state is ignored.

Example:

"CA"

country

enum<string> | null

Two-letter country code in ISO format. See ISO 3166-1 alpha-2.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BF,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ES-CE,

ES-ML,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

IC,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PT-20,

PT-30,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

Example:

"FR"

tax_id

string | null

Tax ID override for a shipping address. Null or blank inherits the customer's tax ID; omission on update preserves the override. Billing addresses cannot have an override.

Example:

"DE123456789"

Response

201 - application/json

string

required

Customer address ID.

Example:

"cad_abc123"

type

enum<string>

required

Whether this is a billing or shipping address.

Available options:

billing,

shipping

Example:

"shipping"

tax_id

string | null

required

Tax ID override for a shipping address. Null or blank inherits the customer's tax ID; omission on update preserves the override. Billing addresses cannot have an override.

Example:

"DE123456789"

name

string | null

Address name.

Example:

"Acme"

line1

string | null

Address first line.

Example:

"5 rue de Paradis"

line2

string | null

Address second line (optional).

Example:

null

city

string | null

Address city.

Example:

"Paris"

zip

string | null

Address ZIP code.

Example:

"75010"

state

string | null

State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. CA for US-CA) for:

United States: state, see ISO 3166-2:US
Canada: province or territory, see ISO 3166-2:CA
Italy: province, see ISO 3166-2:IT
Brazil: state, see ISO 3166-2:BR

A code or a name is accepted (e.g. ON or Ontario); a value that matches neither for these countries is rejected. For any other country, the state is ignored.

Example:

"CA"

country

enum<string> | null

Two-letter country code in ISO format. See ISO 3166-1 alpha-2.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BF,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ES-CE,

ES-ML,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

IC,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PT-20,

PT-30,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

Example:

"FR"

⌘I

Create address

curl --request POST \
  --url https://api.hyperline.co/v1/customers/{customerId}/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "shipping",
  "name": "Acme",
  "line1": "5 rue de Paradis",
  "line2": null,
  "city": "Paris",
  "zip": "75010",
  "state": "CA",
  "country": "FR",
  "tax_id": "DE123456789"
}
'

import requests

url = "https://api.hyperline.co/v1/customers/{customerId}/addresses"

payload = {
    "type": "shipping",
    "name": "Acme",
    "line1": "5 rue de Paradis",
    "line2": None,
    "city": "Paris",
    "zip": "75010",
    "state": "CA",
    "country": "FR",
    "tax_id": "DE123456789"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'shipping',
    name: 'Acme',
    line1: '5 rue de Paradis',
    line2: null,
    city: 'Paris',
    zip: '75010',
    state: 'CA',
    country: 'FR',
    tax_id: 'DE123456789'
  })
};

fetch('https://api.hyperline.co/v1/customers/{customerId}/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/customers/{customerId}/addresses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'shipping',
    'name' => 'Acme',
    'line1' => '5 rue de Paradis',
    'line2' => null,
    'city' => 'Paris',
    'zip' => '75010',
    'state' => 'CA',
    'country' => 'FR',
    'tax_id' => 'DE123456789'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/customers/{customerId}/addresses"

	payload := strings.NewReader("{\n  \"type\": \"shipping\",\n  \"name\": \"Acme\",\n  \"line1\": \"5 rue de Paradis\",\n  \"line2\": null,\n  \"city\": \"Paris\",\n  \"zip\": \"75010\",\n  \"state\": \"CA\",\n  \"country\": \"FR\",\n  \"tax_id\": \"DE123456789\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperline.co/v1/customers/{customerId}/addresses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"shipping\",\n  \"name\": \"Acme\",\n  \"line1\": \"5 rue de Paradis\",\n  \"line2\": null,\n  \"city\": \"Paris\",\n  \"zip\": \"75010\",\n  \"state\": \"CA\",\n  \"country\": \"FR\",\n  \"tax_id\": \"DE123456789\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/customers/{customerId}/addresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"shipping\",\n  \"name\": \"Acme\",\n  \"line1\": \"5 rue de Paradis\",\n  \"line2\": null,\n  \"city\": \"Paris\",\n  \"zip\": \"75010\",\n  \"state\": \"CA\",\n  \"country\": \"FR\",\n  \"tax_id\": \"DE123456789\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "cad_abc123",
  "type": "shipping",
  "tax_id": "DE123456789",
  "name": "Acme",
  "line1": "5 rue de Paradis",
  "line2": null,
  "city": "Paris",
  "zip": "75010",
  "state": "CA",
  "country": "FR"
}